MSC4071: Pagination Token Headers #4071
Conversation
Fizzadar
changed the title
turt2live
added
proposal
Fizzadar
force-pushed
the
pagination-token-headers
branch
from
407b907 to
4efe021
Compare
Fizzadar
changed the title
| change any time soon (if ever). Whether the advantages outweigh the "ugliness" of this hack is up | ||
| for discussion here. | ||
|
|
||
| ## Alternatives |
There was a problem hiding this comment.
matrix-org/matrix-spec#223 is vaguely related and might have some other ideas (and links off to other bits).
There was a problem hiding this comment.
Ha! The one term I didn't search for, preflight :) Linked in alternatives and expanded a bit on things. Essentially I see this MSC as a temporary workaround because it's dead simple to implement, and long run one of the alternatives are the real fix.
|
|
||
| Servers must treat the values exactly the same as the query string versions. | ||
|
|
||
| If a client makes a request specifying both header and query string servers should reject the request |
There was a problem hiding this comment.
Hm I wonder about backwards compatiblity here. If the server doesn't support these headers yet how can a client know about this? Imho it makes sense to allow both to be sent as long as they are identical.
I know this kinda circumvents the point of the proposal however a client could still choose to only send one.
There was a problem hiding this comment.
An alternative could be to just have it somewhere in I guess the versions endpoint denoted that a server supports this. Clients request that endpoint usually anyway.
There was a problem hiding this comment.
Yeah I was thinking this would be indicated to clients via the versions endpoint (but then only included the unstable flag).
Good point about making the switchover, I think specifying both as long as they're the same is reasonable and avoids having to figure out detection.
| ## Proposal | ||
|
|
||
| Super simple - clients may pass pagination tokens as a header instead of query parameters using the | ||
| format `X-Matrix-Pagination-$PARAM`, the following table lists the available headers by endpoint: |
There was a problem hiding this comment.
The X- prefix is deprecated: https://www.rfc-editor.org/rfc/rfc6648 The Matrix- prefix should be enough to ensure that it doesn't collide with any other HTTP headers.
Rendered.
Signed off by Nick @ Beeper (@Fizzadar) [email protected].
Putting this up for discussion prior to doing any implementation work, but should be very quick to implement.